home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / xr240.arc / XROBOT.DOC < prev   
Text File  |  1989-10-12  |  21KB  |  738 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.           XRobot(Tm) Version 2.40
  26.  
  27.           The ultimate robot utility
  28.  
  29.           USER GUIDE
  30.  
  31.  
  32.           1  Legal notice
  33.  
  34.  
  35.              All Joaquim H. Homrighausen products are trademarks or
  36.             registered trademarks of Joaquim H. Homrighausen. Other
  37.               brand and product names are trademarks or registered
  38.                     trademarks of their respective holders.
  39.  
  40.           Copyright 1989 Joaquim H. Homrighausen. All rights reserved.
  41.  
  42.           1.1  Status
  43.  
  44.           This program is not shareware, public domain nor freeware.
  45.           It's simply free of charge. You may use this program and
  46.           distribute it as much as you want if:
  47.  
  48.              1.  No fees are charged in any form. With the single
  49.                  exception of the actual cost to transfer the XRobot
  50.                  archive.
  51.  
  52.              2.  The complete archive is distributed containing only
  53.                  the files put there by me. Any modifications to the
  54.                  archive is a violation of this license.
  55.  
  56.           1.2  Warranty
  57.  
  58.           XRobot is provided "as is", without warranty of any kind,
  59.           either expressed or implied. Joaquim H. Homrighausen only
  60.           guarantees that XRobot will occupy diskspace.
  61.  
  62.           In no event will Joaquim H. Homrighausen be liable to you
  63.           for any damages, including any lost profits, lost savings or
  64.           other incidental or consequential damages arising out of the
  65.           use or inability to use this program.
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.                                      - 2 -
  90.  
  91.           2  Introduction
  92.  
  93.  
  94.           A robot utility is just what the name implies, an easy to
  95.           control utility to aid you in your daily SysOp chores. It
  96.           will simplify tasks like sending multiple files to multiple
  97.           destinations and requesting files from other systems.
  98.  
  99.           These functions can involve a lot of extra work if the
  100.           program you are using does not handle everything properly.
  101.  
  102.           I assume you know enough about FidoNet and terms involved
  103.           with it to understand some "techie" descriptions. This is
  104.           not a beginner's utility - it is easy to use, but it does
  105.           require some knowledge about operating a node in general.
  106.  
  107.           The history of this program is quite long and credits are
  108.           due to several people who gave me ideas and hints (and
  109.           complaints). It would take up too much space if I were to
  110.           list all of them here.
  111.  
  112.           One individual should be named here though, Mats Knuts, the
  113.           Swedish network/region host. When I first started writing
  114.           this program he came with alot of suggestions and helped be
  115.           squeeze a lot of bugs and "undocumented features" out of the
  116.           program.
  117.  
  118.           XRobot has been around since early 1986 and is still getting
  119.           better. My plans are to keep going with it until it's become
  120.           a complete robot utility.
  121.  
  122.  
  123.           3  Basics
  124.  
  125.  
  126.           The basic functions are as mentioned to send and request
  127.           files. You can do this with several options and different
  128.           type of addressing methods. Earlier versions of this
  129.           programs did not support anything but direct addressing.
  130.  
  131.           Most of the data is taken from a file referred to as the
  132.           "control file" which is where you will put your network
  133.           information as well as default settings you wish the program
  134.           to use if nothing else is specified.
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.                                      - 3 -
  149.  
  150.           4  Control file
  151.  
  152.  
  153.           This file is a plain vanilla ASCII (text) file. You can
  154.           create it with your text editor or word processor; or use
  155.           EDLIN (the DOS line editor). If you are using a word
  156.           processor, make sure no additional control characters are
  157.           inserted in the file since this could make the program
  158.           operate a little strange (which you would probably notice).
  159.  
  160.           The program will search for the control file (XROBOT.CTL) in
  161.           the current directory or in the directory specified by the
  162.           environment variable XROBOT. The environment variable will
  163.           be searched before the current directory is scanned for the
  164.           control file.
  165.  
  166.           For an example of how a control file can look, print or list
  167.           the sample XROBOT.CTL file included in this package. There
  168.           are several options that you cannot specify in the control
  169.           file, but give as "command line switches" when you start the
  170.           program. Some of them are required and some are optional.
  171.  
  172.           XRobot treats uppercase and lowercase characters the same,
  173.           so how you enter the commands isn't important.
  174.  
  175.           4.1  Commands
  176.  
  177.           4.1.1  ADDRESS <address>
  178.  
  179.           Your network address. E.g. 1:135/20.1
  180.  
  181.           4.1.2  AKA <address>
  182.  
  183.           Specifies an alternate network address. You can specify up
  184.           to ten AKAs (each one requires a separate AKA command).
  185.  
  186.           4.1.3  MAIL <path>
  187.  
  188.           Defines the DOS path (directory) where you have your
  189.           outgoing and incoming messages stored. This is where
  190.           messages created by the program will end up. If there is no
  191.           trailing backslash the program will automatically append
  192.           one.
  193.  
  194.           4.1.4  USER <user name>
  195.  
  196.           Just for cosmetics, I've implemented a option for you to
  197.           define the name to appear in the "FROM:" field of the
  198.           created message(s). If none is specified, the program
  199.           defaults to "XRobot" followed by the current version number.
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.                                      - 4 -
  208.  
  209.           4.1.5  MSGBITS <msgbit>
  210.  
  211.           This command is quite complex. It specifies what message
  212.           attributes you wish the program do use by default. There are
  213.           five options available. For an explanation of these, consult
  214.           your mailer's documentation. The ones supported are
  215.  
  216.               o  Crash
  217.  
  218.               o  Hold
  219.  
  220.               o  Private
  221.  
  222.               o  Kill/Sent
  223.  
  224.               o  Direct
  225.  
  226.           Each option requires a separate "MSGBITS" line.
  227.  
  228.           4.1.6  ALIAS <alias> <actual address>
  229.  
  230.           The alias command allows to you assign a more human name to
  231.           an address. When specifying addresses, you can instead
  232.           specify an alias.
  233.  
  234.                     alias felix 2:310/11
  235.                     alias rick  1:381/30
  236.                     alias bro   2:201/106
  237.  
  238.           The maximum number of alias definitions that you can have is
  239.           40.
  240.  
  241.           4.1.7  MAP <old drive> <new drive>
  242.  
  243.           If you're running XRobot within a network (LAN) environment,
  244.           drive IDs can change when you're logged on to the network.
  245.  
  246.           For instance, if you have your mailer running on the network
  247.           server, it's running on C. If you have a harddisk on your
  248.           workstation, the network's harddisk will become F (as seen
  249.           from the workstation) so if you send a file that's on the
  250.           network drive from your workstation, XRobot would normally
  251.           think that the drive is F. When your mailer tries to find
  252.           the file, it won't.
  253.  
  254.           By using drive mapping in XRobot, you get around this
  255.           problem very easy. In the example above, you could have "MAP
  256.           F C" in your control file and when XRobot sends a file from
  257.           what it thinks is drive F, it'll remap the drive
  258.           specification for the mailer to C.
  259.  
  260.           The maximum number of drive mappings you can have is 20.
  261.           Please note that the example above might not be true for
  262.           your environment.
  263.  
  264.  
  265.  
  266.                                      - 5 -
  267.  
  268.           5  Running the program
  269.  
  270.  
  271.           XR <action> <filemask> [zone:]net/node[.point] [switches]
  272.  
  273.           5.1  Actions
  274.  
  275.           SEND      Creates file attach messages to the specified
  276.                     systems.
  277.  
  278.           GET       Creates file request messages to the specified
  279.                     systems (note, if this option is used with the /U
  280.                     switch, it'll be an file update request). Note
  281.                     that if you are requesting files, the filemask
  282.                     will not be expanded but used as a request name.
  283.  
  284.           TEXT      Creates a regular message to the specified systems
  285.                     with the /T <file> as message text. When using
  286.                     this mode, the <filemask> parameter will be used
  287.                     as a subject line of the message. If you need
  288.                     spaces in your subject, enclose the paramter with
  289.                     double quotes. E.g. "Hi, this is a subject".
  290.  
  291.           POLL      Creates a dummy (empty) message to force your
  292.                     mailer to call the specified systems to pickup
  293.                     mail. When using this mode, the <filemask>
  294.                     parameter doesn't "exist" (and shouldn't be
  295.                     specified).
  296.  
  297.           COMMANDS  Will display the above listed commands.
  298.  
  299.           SWITCHES  Will display the allowed command line switches
  300.                     (described later).
  301.  
  302.           The <filemask> can be any valid DOS path specification
  303.           including wildcards. If the string contains any wildcards
  304.           they will be expanded to matching files. This is one of the
  305.           most powerful functions of this program. Most other robot
  306.           utilities does not expand this string - they leave it up to
  307.           the mailer when it sends the message to expand it. If you
  308.           have wildcards specified and the transmission is aborted for
  309.           any reason, the program will most likely send the same files
  310.           again at the next attempt.
  311.  
  312.           Following after the file mask is a list of nodes (or
  313.           aliases). You can specify as many as 30 destinations. If you
  314.           wish to use international addressing (across zones) you must
  315.           specify a zone address as well for nodes you wish to use
  316.           this method with (i.e. 2:201/106 for node 106 in net 201
  317.           located in zone 2).
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.                                      - 6 -
  326.  
  327.           5.2  Quotes
  328.  
  329.           If you need to specify more than one word as a parameter to
  330.           a switch or other, put them within double quotes ("). For
  331.           example, to use the below listed /S parameter and specify a
  332.           name which consists of three words:
  333.  
  334.                /S "Joaquim H. Homrighausen"
  335.  
  336.           5.3  Default addressing
  337.  
  338.           It's perfectly valid to only specify partial addresses
  339.           (short form). The program will use your own address for
  340.           default data. To specify a point under your own system, all
  341.           you have to specify is ".<point number>". To specify a node
  342.           in your own net, use "<node number>". Your zone is assumed
  343.           unless you specify a zone.
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.                                      - 7 -
  385.  
  386.           5.4  Command line switches
  387.  
  388.           Command line switches can be preceeded by any single
  389.           character. /C and -C are both valid command line switches.
  390.  
  391.           5.4.1  C - Crash
  392.  
  393.           Enables the Crash (high priority) bit regardless of your
  394.           control file settings.
  395.  
  396.           5.4.2  H - Hold
  397.  
  398.           Enables the Hold (for pickup) bit regardless of your control
  399.           file settings.
  400.  
  401.           5.4.3  K - Kill/sent
  402.  
  403.           Enables the Kill/sent bit regardless of your control file
  404.           settings.
  405.  
  406.           5.4.4  P - Private
  407.  
  408.           Enables the Private bit regardless of your control file
  409.           settings.
  410.  
  411.           5.4.5  R - Kill file/sent
  412.  
  413.           Will add the "Kill file when sent" indicator to the message
  414.           (and is only valid when you send files). It will only work
  415.           on mailers supporting the extended FLAGS set such as
  416.           FrontDoor and D'Bridge.
  417.  
  418.           Note that XRobot allows you to send files marked as read-
  419.           Only. Don't use this option when you're sending read-Only
  420.           files, since your mailer won't be able to remove the file.
  421.  
  422.           5.4.6  X - Truncate file/sent
  423.  
  424.           Will add the "Truncate file when sent" indicator to the
  425.           message (and is only valid when you send files). It will
  426.           only work on mailers supporting the extended FLAGS set such
  427.           as FrontDoor and D'Bridge.
  428.  
  429.           Note that XRobot allows you to send files marked as read-
  430.           Only. Don't use this option when you're sending read-Only
  431.           files, since your mailer won't be able to remove the file.
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.                                      - 8 -
  444.  
  445.           5.4.7  Y - Direct
  446.  
  447.           Will add the "Direct" indicator to the message regardless of
  448.           your control file settings. This flag means that the message
  449.           (and any attached files/requests) should be sent directly to
  450.           the addressee and only allowed to be picked up by the
  451.           addressee - disregarding routing. It will only work on
  452.           mailers supporting the extended FLAGS set such as FrontDoor
  453.           and D'Bridge.
  454.  
  455.           5.4.8  A - Attach path
  456.  
  457.           Normally, the path you specified will be used to specify the
  458.           path where the file will be present when you send it. But
  459.           the file may not be there yet, or it may not be available
  460.           there yet. You can insert another path specifier instead by
  461.           using this command (e.g. /A C:\MAIL\OUTBOUND\).
  462.  
  463.           5.4.9  D - Date mailing
  464.  
  465.           Followed by a numercial value (i.e. /D 10) specifies that
  466.           you only want to send/get the files if they've been updated
  467.           in "nn" days. This means that any file that matches the
  468.           filemask that has not been updated within the specified
  469.           number of days will not be sent. This can be very useful for
  470.           sending out updates if you are a host, hub or region
  471.           coordinator.
  472.  
  473.           5.4.10  S - SysOp
  474.  
  475.           Followed by a string will replace the default "TO: SysOp".
  476.           5.4.11  T - Message text
  477.  
  478.           Followed by a file name (e.g. /T LETTER.TXT) will put the
  479.           contents of the specified file into the message body. If the
  480.           file cannot be found, the program will abort. This can be
  481.           used with all modes except POLL.
  482.  
  483.           5.4.12  U - Update request
  484.  
  485.           If used together with "GET", it enables the update request
  486.           function rather than a regular file request.
  487.  
  488.           5.4.13  Z - Activate zonegates
  489.  
  490.           If any of the nodes specified as receiver of the message has
  491.           got a zone specified (other than yours and other than zero)
  492.           the message will be sent to your zonegate with an INTL line
  493.           in the message body telling the zonegate software where to
  494.           send the message.
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.                                      - 9 -
  503.  
  504.           5.4.14  F - Force use of INTL
  505.  
  506.           You can force XRobot to add INTL addressing to each message
  507.           it creates, this is in particular useful when used with
  508.           semi-zone aware mailers. If this option is enabled, XRobot
  509.           will add the INTL with the proper addresses for every
  510.           message it creates, even if the destination and originating
  511.           address is in the same zone.
  512.  
  513.           5.4.15  1-10 - Specifying an AKA
  514.  
  515.           This allows you to specify from which AKA you want the
  516.           message to send "from". If this option isn't used, the
  517.           address specified as "ADDRESS" in the control file will be
  518.           used.
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.                                      - 10 -
  562.  
  563.           6  Requesting files with passwords
  564.  
  565.  
  566.           There are two methods to indicate a password for a file or
  567.           update file request. SEAdog uses "<filename>,<password>"
  568.           while FrontDoor, Binkley, D'Bridge etc. uses "<filename>
  569.           !<password>".
  570.  
  571.           Both methods (I should say any method) are supported by the
  572.           program. If you're requesting a file from the command line
  573.           with a password, you must enclose the filename and password
  574.           within quotes. I.e. "XR GET FD.ARC !password" or "XR GET
  575.           FD.ARC,password".
  576.  
  577.           You may also specify a password when you do file update
  578.           request(s) from a command file. You may not use the quotes
  579.           here however. To use the same example as above, assume you
  580.           want to request "FD.ARC", you would put "FD.ARC,password" or
  581.           "FD.ARC !password" on one line in the command file (without
  582.           the quote characters).
  583.  
  584.           For an example of a command file for file update requests,
  585.           see UPDREQ.TXT included in the distribution archive.
  586.  
  587.  
  588.           7  Reporting bugs
  589.  
  590.  
  591.           If you think you've found a bug, I'd appreciate hearing
  592.           about it. But please make sure you understand what the
  593.           function you're trying to use is supposed to do before you
  594.           tell me about the bug.
  595.  
  596.  
  597.           8  Contacting the author
  598.  
  599.  
  600.           If you need to reach me, you can send e-mail (netmail) to
  601.           one of the following addresses:
  602.  
  603.           FidoNet        1:135/20
  604.           AlterNet       7:48/20
  605.           SIGNet         26:1305/100
  606.  
  607.           Or you can call the FrontDoor Headquarters BBS at
  608.           1-305-596-2904 (14.4K HST) and enter a message to SysOp.
  609.  
  610.           Thank you for using XRobot.
  611.  
  612.           Joaquim H. Homrighausen
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.                                      - 11 -
  621.  
  622.           9  Technical notes
  623.  
  624.  
  625.           XRobot was written using Turbo C 2.00 from Borland
  626.           International and the Microsoft Macro Assembler 5.10. The
  627.           screen output is done through an undocumented function call:
  628.           Interrupt service 29h. It's non-redirectable.
  629.  
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.                                      - 12 -
  680.  
  681.  
  682.  
  683.  
  684.  
  685.  
  686.  
  687.                                  Contents
  688.  
  689.  
  690.                   1  Legal notice  . . . . . . . . . . . . . .  2
  691.                      1.1  Status . . . . . . . . . . . . . . .  2
  692.                      1.2  Warranty . . . . . . . . . . . . . .  2
  693.                   2  Introduction  . . . . . . . . . . . . . .  3
  694.                   3  Basics  . . . . . . . . . . . . . . . . .  3
  695.                   4  Control file  . . . . . . . . . . . . . .  4
  696.                      4.1  Commands . . . . . . . . . . . . . .  4
  697.                         4.1.1  ADDRESS <address> . . . . . . .  4
  698.                         4.1.2  AKA <address> . . . . . . . . .  4
  699.                         4.1.3  MAIL <path> . . . . . . . . . .  4
  700.                         4.1.4  USER <user name>  . . . . . . .  4
  701.                         4.1.5  MSGBITS <msgbit>  . . . . . . .  5
  702.                         4.1.6  ALIAS <alias> <actual address> . 5
  703.                         4.1.7  MAP <old drive> <new drive> . .  5
  704.                   5  Running the program . . . . . . . . . . .  6
  705.                      5.1  Actions  . . . . . . . . . . . . . .  6
  706.                      5.2  Quotes . . . . . . . . . . . . . . .  7
  707.                      5.3  Default addressing . . . . . . . . .  7
  708.                      5.4  Command line switches  . . . . . . .  8
  709.                         5.4.1  C - Crash . . . . . . . . . . .  8
  710.                         5.4.2  H - Hold  . . . . . . . . . . .  8
  711.                         5.4.3  K - Kill/sent . . . . . . . . .  8
  712.                         5.4.4  P - Private . . . . . . . . . .  8
  713.                         5.4.5  R - Kill file/sent  . . . . . .  8
  714.                         5.4.6  X - Truncate file/sent  . . . .  8
  715.                         5.4.7  Y - Direct  . . . . . . . . . .  9
  716.                         5.4.8  A - Attach path . . . . . . . .  9
  717.                         5.4.9  D - Date mailing  . . . . . . .  9
  718.                         5.4.10  S - SysOp  . . . . . . . . . .  9
  719.                         5.4.11  T - Message text . . . . . . .  9
  720.                         5.4.12  U - Update request . . . . . .  9
  721.                         5.4.13  Z - Activate zonegates . . . .  9
  722.                         5.4.14  F - Force use of INTL  . . . . 10
  723.                         5.4.15  1-10 - Specifying an AKA . . . 10
  724.                   6  Requesting files with passwords . . . . . 11
  725.                   7  Reporting bugs  . . . . . . . . . . . . . 11
  726.                   8  Contacting the author . . . . . . . . . . 11
  727.                   9  Technical notes . . . . . . . . . . . . . 12
  728.  
  729.  
  730.  
  731.  
  732.  
  733.  
  734.  
  735.  
  736.  
  737.  
  738.                                        i